home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1996 May: Tool Chest / Developer CD Series May 1996 (Tool Chest) (Apple Computer) (1996).iso / Sample Code / Snippets / Testing & Debugging / Audit / Audit ReadMe.note < prev    next >
Encoding:
Text File  |  1993-10-07  |  2.0 KB  |  52 lines  |  [TEXT/ttxt]
  1. Audit Library
  2. Copyright © 1992-93, Apple Computer Inc.
  3.  
  4. Audit is a small library of functions that provide an unobtrusive
  5. event tracing capability to applications, drivers, code-resources,
  6. call-backs, and any other "flavor" of Macintosh software.
  7.  
  8. The initialization function (InitAudit) must be called from a
  9. "memory-safe" environment (i.e., InitAudit may not be called from
  10. a driver completion routine), but all other functions may be called
  11. at any time.
  12.  
  13. The audit functions are defined by comments in Audit.h and Audit.c.
  14. A MicrosoftWord 5.0 document, “About Audit” documents the program.
  15.  
  16. The DisplayAudit application may be used to follow the execution
  17. of a program being audited.  It can display auditing from several
  18. sources, and allows logging the audited data to a text file.
  19.  
  20. The following are provided:
  21.  
  22. • Audit.h -- this header file must be included by all functions
  23.   that use Audit. It defines the structures and kernel functions
  24.   that are needed.
  25. • Audit.c -- this file contains the C functions that support
  26.   debugging. It is linked into all modules that need this support.
  27. • AuditDCMD.c -- this is the source for a MacsBug dcmd (formatting
  28.   command) that can be used to display the current debug log data
  29.   area within MacsBug or, presumably, TMON.
  30. • MakeFile -- this MPW command file builds and installs AuditDCMD.
  31.   It can also build DisplayAudit.
  32. • AuditEntryFormat.c -- this file formats an audit record.
  33. • DisplayAudit.π -- This Think C Project file builds DisplayAudit.
  34. • MakeFile -- this MPW MakeFile builds the Audit DCMD and the
  35. DisplayAudit application.
  36. • dcmds -- this folder contains a copy of the MacsBug dcmd support
  37.   functions.
  38.  
  39. Building:
  40.  
  41. • Use the MakeFile to compile and install Audit in your MacsBug
  42.    preferences file. You must reboot your system to use the audit dcmd.
  43. • Build DisplayAudit using either the MPW or Think version.
  44. • Copy Audit.h and Audit.c to the source folders for applications
  45.   (etc.) that need logging capability.
  46.  
  47. Requirements
  48. •    MPW 3.2
  49. •    Think C 6.0
  50.  
  51.  
  52.